home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / catD / drv_getparm.z / drv_getparm
Encoding:
Text File  |  2002-10-03  |  7.2 KB  |  132 lines
  1.  
  2.  
  3.  
  4. ddddrrrrvvvv____ggggeeeettttppppaaaarrrrmmmm((((DDDD3333))))                                                ddddrrrrvvvv____ggggeeeettttppppaaaarrrrmmmm((((DDDD3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _dddd_rrrr_vvvv______gggg_eeee_tttt_pppp_aaaa_rrrr_mmmm - retrieve kernel state information
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_tttt_yyyy_pppp_eeee_ssss_...._hhhh_>>>>
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_dddd_dddd_iiii_...._hhhh_>>>>
  14.      _iiii_nnnn_tttt _dddd_rrrr_vvvv______gggg_eeee_tttt_pppp_aaaa_rrrr_mmmm_((((_uuuu_llll_oooo_nnnn_gggg______tttt _p_a_r_m_,,,, _uuuu_llll_oooo_nnnn_gggg______tttt _****_v_a_l_u_e__p_))))_;;;;
  15.  
  16.    AAAArrrrgggguuuummmmeeeennnnttttssss
  17.      _p_a_r_m      The kernel parameter to be obtained.
  18.  
  19.      _v_a_l_u_e__p   A pointer to the data space into which the value of the
  20.                parameter is to be copied.
  21.  
  22. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  23.      _dddd_rrrr_vvvv______gggg_eeee_tttt_pppp_aaaa_rrrr_mmmm returns the value of the parameter specified by _p_a_r_m in the
  24.      location pointed to by _v_a_l_u_e__p.
  25.  
  26.    RRRReeeettttuuuurrrrnnnn VVVVaaaalllluuuueeeessss
  27.      On success, _dddd_rrrr_vvvv______gggg_eeee_tttt_pppp_aaaa_rrrr_mmmm returns 0.  On failure it returns -1 to indicate
  28.      that _p_a_r_m specified an invalid parameter.
  29.  
  30. UUUUSSSSAAAAGGGGEEEE
  31.      _dddd_rrrr_vvvv______gggg_eeee_tttt_pppp_aaaa_rrrr_mmmm does not explicitly check to see whether the driver has the
  32.      appropriate context when the function is called.  It is the
  33.      responsibility of the driver to use this function only when it is
  34.      appropriate to do so and to correctly declare the data space needed.
  35.  
  36.      Valid values for _p_a_r_m are:
  37.  
  38.           _LLLL_BBBB_OOOO_LLLL_TTTT     Read the number of clock ticks since the last system
  39.                     reboot.  The difference between the values returned from
  40.                     successive calls to retrieve this parameter provides an
  41.                     indication of the elapsed time between the calls in units
  42.                     of clock ticks.  The length of a clock tick can vary
  43.                     across different implementations, and therefore drivers
  44.                     should not include any hard-coded assumptions about the
  45.                     length of a tick.  The _dddd_rrrr_vvvv______hhhh_zzzz_tttt_oooo_uuuu_ssss_eeee_cccc(D3) and
  46.                     _dddd_rrrr_vvvv______uuuu_ssss_eeee_cccc_tttt_oooo_hhhh_zzzz(D3) functions can be used, as necessary, to
  47.                     convert between clock ticks and microseconds
  48.                     (implementation independent units).
  49.  
  50.           _TTTT_IIII_MMMM_EEEE      Read the time in seconds.  This is the same time value
  51.                     that is returned by the _tttt_iiii_mmmm_eeee(2) system call.  The value is
  52.                     defined as the time in seconds since 00:00:00 GMT, January
  53.                     1, 1970.  This definition presupposes that the
  54.                     administrator has set the correct system date and time.
  55.  
  56.           _UUUU_CCCC_RRRR_EEEE_DDDD     Retrieve a pointer to the credential structure describing
  57.                     the current user credentials for the current process.  The
  58.                     value returned in *_v_a_l_u_e__p is of type _((((_cccc_rrrr_eeee_dddd______tttt _****_)))) and the
  59.                     only valid use of the value is as an argument to
  60.  
  61.  
  62.                                                                         PPPPaaaaggggeeee 1111
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. ddddrrrrvvvv____ggggeeeettttppppaaaarrrrmmmm((((DDDD3333))))                                                ddddrrrrvvvv____ggggeeeettttppppaaaarrrrmmmm((((DDDD3333))))
  70.  
  71.  
  72.  
  73.                     _dddd_rrrr_vvvv______pppp_rrrr_iiii_vvvv(D3).  Since this value is associated with the
  74.                     current process, the caller must have process context
  75.                     (that is, must be at base level) when attempting to
  76.                     retrieve this value.  Also, this value should only be used
  77.                     in the context of the process in which it was retrieved.
  78.  
  79.           _PPPP_GGGG_RRRR_PPPP      Read the process group identification number. This number
  80.                     determines which processes should receive a HANGUP or
  81.                     BREAK signal when detected by a driver.
  82.  
  83.           _PPPP_PPPP_IIII_DDDD      Read process identification number.
  84.  
  85.           _PPPP_SSSS_IIII_DDDD      Read process identification number.
  86.  
  87.    LLLLeeeevvvveeeellll
  88.      Base only when using the _UUUU_CCCC_RRRR_EEEE_DDDD_PPPP _aaaa_rrrr_gggg_uuuu_mmmm_eeee_nnnn_tttt _vvvv_aaaa_llll_uuuu_eeee_ssss_....
  89.      _IIII_nnnn_iiii_tttt_iiii_aaaa_llll_iiii_zzzz_aaaa_tttt_iiii_oooo_nnnn_,,,, _BBBB_aaaa_ssss_eeee_,,,, _oooo_rrrr _IIII_nnnn_tttt_eeee_rrrr_rrrr_uuuu_pppp_tttt _wwww_hhhh_eeee_nnnn _uuuu_ssss_iiii_nnnn_gggg _tttt_hhhh_eeee _LLLL_BBBB_OOOO_LLLL_TTTT _oooo_rrrr _TTTT_IIII_MMMM_EEEE _aaaa_rrrr_gggg_uuuu_mmmm_eeee_nnnn_tttt
  90.      _vvvv_aaaa_llll_uuuu_eeee_ssss_....
  91.  
  92.    SSSSyyyynnnncccchhhhrrrroooonnnniiiizzzzaaaattttiiiioooonnnn CCCCoooonnnnssssttttrrrraaaaiiiinnnnttttssss
  93.      Does not sleep.
  94.      Driver-defined basic locks, read/write locks, and sleep locks may be held
  95.      across calls to this function
  96.  
  97. RRRREEEEFFFFEEEERRRREEEENNNNCCCCEEEESSSS
  98.      _dddd_rrrr_vvvv______hhhh_zzzz_tttt_oooo_uuuu_ssss_eeee_cccc(D3), _dddd_rrrr_vvvv______pppp_rrrr_iiii_vvvv(D3), _dddd_rrrr_vvvv______uuuu_ssss_eeee_cccc_tttt_oooo_hhhh_zzzz(D3)
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.                                                                         PPPPaaaaggggeeee 2222
  129.  
  130.  
  131.  
  132.